
































  
  


  

  
  	
  

  

	
	

	
	
	
	
	




  
















	
	
	
	
	
	
	
	
	
	
  
  


	


	
	
	
	
	
	
	
	
	
	
	
	
	
	
	
	
	
	




    
  






  
    
  




	
	
	
	
	



<!--NewPage-->
<HTML>

<!-- Mirrored from delerium:8503/cfcdoc/content.cfm?file=C%3A%5CInetpub%5Cwwwroot%5Ctransfer%2Droot%5Ctransfer%5Ccom%5Ctql%5CQuery%2Ecfc by HTTrack Website Copier/3.x [XR&CO'2006], Sat, 07 Apr 2007 03:17:40 GMT -->
<!-- Added by HTTrack --><meta http-equiv="content-type" content="text/html;charset=UTF-8"><!-- /Added by HTTrack -->
<HEAD>

<!-- Generated by CFDoc on 07-Apr-2007 01:17 PM -->

<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
</HEAD>
<BODY>


	



<HR>
<!-- ======== START OF CLASS DATA ======== -->

<div style="float:left;">

<a href="default.html" style="float: right;">Documentation home page</a>
</div>
<H2>
<span style="font-size: smaller">
<a href="componentsd9bf.html" target="components">transfer.com.tql</a>
</span>
<BR>
Component Query</H2>


<PRE>
<B>transfer.com.tql.Query</B>
</PRE>


<HR>
The TQL Query objects


<HR>

<P>


<!-- ========== PROPERTY SUMMARY =========== -->

<A NAME="property_summary"><!-- --></A>






<!-- ========== METHOD SUMMARY =========== -->




<A NAME="method_summary"><!-- --></A>

<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">

<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=2><FONT SIZE="+2">
<B>Method Summary</B></FONT></TD>
</TR>











	





	





	





	





	





	





	





	





	





	





	





	





	





	





	





	





	





	



	<TR BGCOLOR="eeeeff" CLASS="TableRowColorConstructor">
	<TD ALIGN="right" VALIGN="top" WIDTH="1%">
	<CODE>public <a href="content79a0.html" target="_self">Query</a></CODE></TD>
	<TD><CODE><B><A HREF="#init()">init</A></B>(<a href="nativetypes.html#detail_string">string</a> tql)</CODE>
	
		<BR>
		&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructor
	</TD>
	</TR>
	

	<TR BGCOLOR="white" CLASS="TableRowColor">
	<TD ALIGN="right" VALIGN="top" WIDTH="1%">
	<CODE>private <a href="nativetypes.html#detail_void" target="_self">void</a></CODE></TD>
	<TD><CODE><B><A HREF="#addMappedParameter()">addMappedParameter</A></B>(<a href="nativetypes.html#detail_string">string</a> mapName,&nbsp;<a href="nativetypes.html#detail_struct">struct</a> mapValues)</CODE>
	
		<BR>
		&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Adds a mapped param to the collection
	
	
	</TD>
	</TR>
	
	<TR BGCOLOR="white" CLASS="TableRowColor">
	<TD ALIGN="right" VALIGN="top" WIDTH="1%">
	<CODE>public <a href="nativetypes.html#detail_void" target="_self">void</a></CODE></TD>
	<TD><CODE><B><A HREF="#clean()">clean</A></B>()</CODE>
	
		<BR>
		&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Cleans the Query object for reuse
	
	
	</TD>
	</TR>
	
	<TR BGCOLOR="white" CLASS="TableRowColor">
	<TD ALIGN="right" VALIGN="top" WIDTH="1%">
	<CODE>private <a href="nativetypes.html#detail_void" target="_self">void</a></CODE></TD>
	<TD><CODE><B><A HREF="#configure()">configure</A></B>(<a href="nativetypes.html#detail_string">string</a> tql)</CODE>
	
		<BR>
		&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Configuration
	
	
	</TD>
	</TR>
	
	<TR BGCOLOR="white" CLASS="TableRowColor">
	<TD ALIGN="right" VALIGN="top" WIDTH="1%">
	<CODE>public <a href="nativetypes.html#detail_boolean" target="_self">boolean</a></CODE></TD>
	<TD><CODE><B><A HREF="#getAliasColumns()">getAliasColumns</A></B>()</CODE>
	
	
	</TD>
	</TR>
	
	<TR BGCOLOR="white" CLASS="TableRowColor">
	<TD ALIGN="right" VALIGN="top" WIDTH="1%">
	<CODE>public <a href="nativetypes.html#detail_boolean" target="_self">boolean</a></CODE></TD>
	<TD><CODE><B><A HREF="#getCacheEvaluation()">getCacheEvaluation</A></B>()</CODE>
	
	
	</TD>
	</TR>
	
	<TR BGCOLOR="white" CLASS="TableRowColor">
	<TD ALIGN="right" VALIGN="top" WIDTH="1%">
	<CODE>public <a href="nativetypes.html#detail_boolean" target="_self">boolean</a></CODE></TD>
	<TD><CODE><B><A HREF="#getDistinctMode()">getDistinctMode</A></B>()</CODE>
	
	
	</TD>
	</TR>
	
	<TR BGCOLOR="white" CLASS="TableRowColor">
	<TD ALIGN="right" VALIGN="top" WIDTH="1%">
	<CODE>private <a href="nativetypes.html#detail_struct" target="_self">struct</a></CODE></TD>
	<TD><CODE><B><A HREF="#getMappedParameter()">getMappedParameter</A></B>(<a href="nativetypes.html#detail_string">string</a> mapName)</CODE>
	
		<BR>
		&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;returns a mapped parameter
	
	
	</TD>
	</TR>
	
	<TR BGCOLOR="white" CLASS="TableRowColor">
	<TD ALIGN="right" VALIGN="top" WIDTH="1%">
	<CODE>private <a href="nativetypes.html#detail_struct" target="_self">struct</a></CODE></TD>
	<TD><CODE><B><A HREF="#getMappedParameters()">getMappedParameters</A></B>()</CODE>
	
	
	</TD>
	</TR>
	
	<TR BGCOLOR="white" CLASS="TableRowColor">
	<TD ALIGN="right" VALIGN="top" WIDTH="1%">
	<CODE>public <a href="nativetypes.html#detail_struct" target="_self">struct</a></CODE></TD>
	<TD><CODE><B><A HREF="#getParam()">getParam</A></B>(<a href="nativetypes.html#detail_string">string</a> mapName)</CODE>
	
		<BR>
		&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a mapped param
	
	
	</TD>
	</TR>
	
	<TR BGCOLOR="white" CLASS="TableRowColor">
	<TD ALIGN="right" VALIGN="top" WIDTH="1%">
	<CODE>public <a href="nativetypes.html#detail_string" target="_self">string</a></CODE></TD>
	<TD><CODE><B><A HREF="#getTQL()">getTQL</A></B>()</CODE>
	
	
	</TD>
	</TR>
	
	<TR BGCOLOR="white" CLASS="TableRowColor">
	<TD ALIGN="right" VALIGN="top" WIDTH="1%">
	<CODE>public <a href="nativetypes.html#detail_void" target="_self">void</a></CODE></TD>
	<TD><CODE><B><A HREF="#setAliasColumns()">setAliasColumns</A></B>(<a href="nativetypes.html#detail_boolean">boolean</a> AliasColumns)</CODE>
	
		<BR>
		&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;If true, columns are alias'ed to the property names. Defaults to true.
	
	
	</TD>
	</TR>
	
	<TR BGCOLOR="white" CLASS="TableRowColor">
	<TD ALIGN="right" VALIGN="top" WIDTH="1%">
	<CODE>public <a href="nativetypes.html#detail_void" target="_self">void</a></CODE></TD>
	<TD><CODE><B><A HREF="#setCacheEvaluation()">setCacheEvaluation</A></B>(<a href="nativetypes.html#detail_boolean">boolean</a> CacheEvaluation)</CODE>
	
		<BR>
		&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;When set to true, Transfer knows that the TQL isn't going to change, and caches the evaluation of the TQL for reuse. Defaults to: false
	
	
	</TD>
	</TR>
	
	<TR BGCOLOR="white" CLASS="TableRowColor">
	<TD ALIGN="right" VALIGN="top" WIDTH="1%">
	<CODE>public <a href="nativetypes.html#detail_void" target="_self">void</a></CODE></TD>
	<TD><CODE><B><A HREF="#setDistinctMode()">setDistinctMode</A></B>(<a href="nativetypes.html#detail_boolean">boolean</a> DistinctMode)</CODE>
	
		<BR>
		&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;When set to true, the query is run as DISTINCT. Defaults to false.
	
	
	</TD>
	</TR>
	
	<TR BGCOLOR="white" CLASS="TableRowColor">
	<TD ALIGN="right" VALIGN="top" WIDTH="1%">
	<CODE>private <a href="nativetypes.html#detail_void" target="_self">void</a></CODE></TD>
	<TD><CODE><B><A HREF="#setMappedParameters()">setMappedParameters</A></B>(<a href="nativetypes.html#detail_struct">struct</a> MappedParameters)</CODE>
	
	
	</TD>
	</TR>
	
	<TR BGCOLOR="white" CLASS="TableRowColor">
	<TD ALIGN="right" VALIGN="top" WIDTH="1%">
	<CODE>public <a href="nativetypes.html#detail_void" target="_self">void</a></CODE></TD>
	<TD><CODE><B><A HREF="#setParam()">setParam</A></B>(<a href="nativetypes.html#detail_string">string</a> name,&nbsp;[<a href="nativetypes.html#detail_string">string</a> value],&nbsp;[<a href="nativetypes.html#detail_string">string</a> type="string"],&nbsp;[<a href="nativetypes.html#detail_boolean">boolean</a> list="false"],&nbsp;[<a href="nativetypes.html#detail_boolean">boolean</a> null="false"])</CODE>
	
		<BR>
		&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets a mapped parameter
	
	
	</TD>
	</TR>
	
	<TR BGCOLOR="white" CLASS="TableRowColor">
	<TD ALIGN="right" VALIGN="top" WIDTH="1%">
	<CODE>private <a href="nativetypes.html#detail_void" target="_self">void</a></CODE></TD>
	<TD><CODE><B><A HREF="#setTQL()">setTQL</A></B>(<a href="nativetypes.html#detail_string">string</a> TQL)</CODE>
	
	
	</TD>
	</TR>
	
	<TR BGCOLOR="white" CLASS="TableRowColor">
	<TD ALIGN="right" VALIGN="top" WIDTH="1%">
	<CODE>private <a href="nativetypes.html#detail_any" target="_self">any</a></CODE></TD>
	<TD><CODE><B><A HREF="#throw()">throw</A></B>(<a href="nativetypes.html#detail_string">string</a> type,&nbsp;<a href="nativetypes.html#detail_string">string</a> message,&nbsp;[<a href="nativetypes.html#detail_string">string</a> detail=""])</CODE>
	
		<BR>
		&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Throws an Exception
	
	
	</TD>
	</TR>
	
</TABLE>



&nbsp;
<P>



<!-- ============ METHOD DETAIL ========== -->


<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Method Detail</B></FONT></TD>
</TR>
</TABLE>












<A NAME="addMappedParameter()"><!-- --></A><H3>
addMappedParameter</H3>

<PRE>
private <A HREF="nativetypes.html#detail_void" title="">void</A> <B>addMappedParameter</B>(<a href="nativetypes.html#detail_string">string</a> mapName,&nbsp;<a href="nativetypes.html#detail_struct">struct</a> mapValues)</PRE>
<DL>
  <DD>
  	
  	
		Adds a mapped param to the collection
	    <P>
	
	
		<DL>
		  <DT><B>Parameters:</B></DT>
			
			  <DD><code><a href="nativetypes.html#detail_string">string</a> mapName</code> - The name to map it to</DD>
			
			  <DD><code><a href="nativetypes.html#detail_struct">struct</a> mapValues</code> - The struct of values to be mapped</DD>
			
		</DL>
	
	
    
  </DD>
</DL>
<HR>




<A NAME="clean()"><!-- --></A><H3>
clean</H3>

<PRE>
public <A HREF="nativetypes.html#detail_void" title="">void</A> <B>clean</B>()</PRE>
<DL>
  <DD>
  	
  	
		Cleans the Query object for reuse
	    <P>
	
	
	
    
  </DD>
</DL>
<HR>




<A NAME="configure()"><!-- --></A><H3>
configure</H3>

<PRE>
private <A HREF="nativetypes.html#detail_void" title="">void</A> <B>configure</B>(<a href="nativetypes.html#detail_string">string</a> tql)</PRE>
<DL>
  <DD>
  	
  	
		Configuration
	    <P>
	
	
		<DL>
		  <DT><B>Parameters:</B></DT>
			
			  <DD><code><a href="nativetypes.html#detail_string">string</a> tql</code> - The tql to set the query to</DD>
			
		</DL>
	
	
    
  </DD>
</DL>
<HR>




<A NAME="getAliasColumns()"><!-- --></A><H3>
getAliasColumns</H3>

<PRE>
public <A HREF="nativetypes.html#detail_boolean" title="">boolean</A> <B>getAliasColumns</B>()</PRE>
<DL>
  <DD>
  	
  	
	
	
    
  </DD>
</DL>
<HR>




<A NAME="getCacheEvaluation()"><!-- --></A><H3>
getCacheEvaluation</H3>

<PRE>
public <A HREF="nativetypes.html#detail_boolean" title="">boolean</A> <B>getCacheEvaluation</B>()</PRE>
<DL>
  <DD>
  	
  	
	
	
    
  </DD>
</DL>
<HR>




<A NAME="getDistinctMode()"><!-- --></A><H3>
getDistinctMode</H3>

<PRE>
public <A HREF="nativetypes.html#detail_boolean" title="">boolean</A> <B>getDistinctMode</B>()</PRE>
<DL>
  <DD>
  	
  	
	
	
    
  </DD>
</DL>
<HR>




<A NAME="getMappedParameter()"><!-- --></A><H3>
getMappedParameter</H3>

<PRE>
private <A HREF="nativetypes.html#detail_struct" title="">struct</A> <B>getMappedParameter</B>(<a href="nativetypes.html#detail_string">string</a> mapName)</PRE>
<DL>
  <DD>
  	
  	
		returns a mapped parameter
	    <P>
	
	
		<DL>
		  <DT><B>Parameters:</B></DT>
			
			  <DD><code><a href="nativetypes.html#detail_string">string</a> mapName</code> - The name to map the param to</DD>
			
		</DL>
	
	
    
  </DD>
</DL>
<HR>




<A NAME="getMappedParameters()"><!-- --></A><H3>
getMappedParameters</H3>

<PRE>
private <A HREF="nativetypes.html#detail_struct" title="">struct</A> <B>getMappedParameters</B>()</PRE>
<DL>
  <DD>
  	
  	
	
	
    
  </DD>
</DL>
<HR>




<A NAME="getParam()"><!-- --></A><H3>
getParam</H3>

<PRE>
public <A HREF="nativetypes.html#detail_struct" title="">struct</A> <B>getParam</B>(<a href="nativetypes.html#detail_string">string</a> mapName)</PRE>
<DL>
  <DD>
  	
  	
		Returns a mapped param
	    <P>
	
	
		<DL>
		  <DT><B>Parameters:</B></DT>
			
			  <DD><code><a href="nativetypes.html#detail_string">string</a> mapName</code> - The name of the mapping</DD>
			
		</DL>
	
	
    
  </DD>
</DL>
<HR>




<A NAME="getTQL()"><!-- --></A><H3>
getTQL</H3>

<PRE>
public <A HREF="nativetypes.html#detail_string" title="">string</A> <B>getTQL</B>()</PRE>
<DL>
  <DD>
  	
  	
	
	
    
  </DD>
</DL>
<HR>




<A NAME="init()"><!-- --></A><H3>
init</H3>

<PRE>
public <A HREF="content79a0.html" title="">transfer.com.tql.Query</A> <B>init</B>(<a href="nativetypes.html#detail_string">string</a> tql)</PRE>
<DL>
  <DD>
  	
  	
		Constructor
	    <P>
	
	
		<DL>
		  <DT><B>Parameters:</B></DT>
			
			  <DD><code><a href="nativetypes.html#detail_string">string</a> tql</code> - The TQL to set the query to</DD>
			
		</DL>
	
	
    
  </DD>
</DL>
<HR>




<A NAME="setAliasColumns()"><!-- --></A><H3>
setAliasColumns</H3>

<PRE>
public <A HREF="nativetypes.html#detail_void" title="">void</A> <B>setAliasColumns</B>(<a href="nativetypes.html#detail_boolean">boolean</a> AliasColumns)</PRE>
<DL>
  <DD>
  	
  	
		If true, columns are alias'ed to the property names. Defaults to true.
	    <P>
	
	
		<DL>
		  <DT><B>Parameters:</B></DT>
			
			  <DD><code><a href="nativetypes.html#detail_boolean">boolean</a> AliasColumns</code></DD>
			
		</DL>
	
	
    
  </DD>
</DL>
<HR>




<A NAME="setCacheEvaluation()"><!-- --></A><H3>
setCacheEvaluation</H3>

<PRE>
public <A HREF="nativetypes.html#detail_void" title="">void</A> <B>setCacheEvaluation</B>(<a href="nativetypes.html#detail_boolean">boolean</a> CacheEvaluation)</PRE>
<DL>
  <DD>
  	
  	
		When set to true, Transfer knows that the TQL isn't going to change, and caches the evaluation of the TQL for reuse. Defaults to: false
	    <P>
	
	
		<DL>
		  <DT><B>Parameters:</B></DT>
			
			  <DD><code><a href="nativetypes.html#detail_boolean">boolean</a> CacheEvaluation</code></DD>
			
		</DL>
	
	
    
  </DD>
</DL>
<HR>




<A NAME="setDistinctMode()"><!-- --></A><H3>
setDistinctMode</H3>

<PRE>
public <A HREF="nativetypes.html#detail_void" title="">void</A> <B>setDistinctMode</B>(<a href="nativetypes.html#detail_boolean">boolean</a> DistinctMode)</PRE>
<DL>
  <DD>
  	
  	
		When set to true, the query is run as DISTINCT. Defaults to false.
	    <P>
	
	
		<DL>
		  <DT><B>Parameters:</B></DT>
			
			  <DD><code><a href="nativetypes.html#detail_boolean">boolean</a> DistinctMode</code></DD>
			
		</DL>
	
	
    
  </DD>
</DL>
<HR>




<A NAME="setMappedParameters()"><!-- --></A><H3>
setMappedParameters</H3>

<PRE>
private <A HREF="nativetypes.html#detail_void" title="">void</A> <B>setMappedParameters</B>(<a href="nativetypes.html#detail_struct">struct</a> MappedParameters)</PRE>
<DL>
  <DD>
  	
  	
	
		<DL>
		  <DT><B>Parameters:</B></DT>
			
			  <DD><code><a href="nativetypes.html#detail_struct">struct</a> MappedParameters</code></DD>
			
		</DL>
	
	
    
  </DD>
</DL>
<HR>




<A NAME="setParam()"><!-- --></A><H3>
setParam</H3>

<PRE>
public <A HREF="nativetypes.html#detail_void" title="">void</A> <B>setParam</B>(<a href="nativetypes.html#detail_string">string</a> name,&nbsp;[<a href="nativetypes.html#detail_string">string</a> value],&nbsp;[<a href="nativetypes.html#detail_string">string</a> type="string"],&nbsp;[<a href="nativetypes.html#detail_boolean">boolean</a> list="false"],&nbsp;[<a href="nativetypes.html#detail_boolean">boolean</a> null="false"])</PRE>
<DL>
  <DD>
  	
  	
		Sets a mapped parameter
	    <P>
	
	
		<DL>
		  <DT><B>Parameters:</B></DT>
			
			  <DD><code><a href="nativetypes.html#detail_string">string</a> name</code> - The name of the mapping</DD>
			
			  <DD><code>[<a href="nativetypes.html#detail_string">string</a> value]</code> - The value of the mapping, required if 'null' is false</DD>
			
			  <DD><code>[<a href="nativetypes.html#detail_string">string</a> type="string"]</code> - The type of the mapped value: string, date, boolean, numeric, GUID, UUID</DD>
			
			  <DD><code>[<a href="nativetypes.html#detail_boolean">boolean</a> list="false"]</code> - if the mapped value is a list</DD>
			
			  <DD><code>[<a href="nativetypes.html#detail_boolean">boolean</a> null="false"]</code> - If the value is actually null</DD>
			
		</DL>
	
	
    
  </DD>
</DL>
<HR>




<A NAME="setTQL()"><!-- --></A><H3>
setTQL</H3>

<PRE>
private <A HREF="nativetypes.html#detail_void" title="">void</A> <B>setTQL</B>(<a href="nativetypes.html#detail_string">string</a> TQL)</PRE>
<DL>
  <DD>
  	
  	
	
		<DL>
		  <DT><B>Parameters:</B></DT>
			
			  <DD><code><a href="nativetypes.html#detail_string">string</a> TQL</code></DD>
			
		</DL>
	
	
    
  </DD>
</DL>
<HR>




<A NAME="throw()"><!-- --></A><H3>
throw</H3>

<PRE>
private <A HREF="nativetypes.html#detail_any" title="">any</A> <B>throw</B>(<a href="nativetypes.html#detail_string">string</a> type,&nbsp;<a href="nativetypes.html#detail_string">string</a> message,&nbsp;[<a href="nativetypes.html#detail_string">string</a> detail=""])</PRE>
<DL>
  <DD>
  	
  	
		Throws an Exception
	    <P>
	
	
		<DL>
		  <DT><B>Parameters:</B></DT>
			
			  <DD><code><a href="nativetypes.html#detail_string">string</a> type</code> - The type of exception</DD>
			
			  <DD><code><a href="nativetypes.html#detail_string">string</a> message</code> - The message to accompany the exception</DD>
			
			  <DD><code>[<a href="nativetypes.html#detail_string">string</a> detail=""]</code> - The detail message for the exception</DD>
			
		</DL>
	
	
    
  </DD>
</DL>
<HR>







</BODY>

<!-- Mirrored from delerium:8503/cfcdoc/content.cfm?file=C%3A%5CInetpub%5Cwwwroot%5Ctransfer%2Droot%5Ctransfer%5Ccom%5Ctql%5CQuery%2Ecfc by HTTrack Website Copier/3.x [XR&CO'2006], Sat, 07 Apr 2007 03:17:40 GMT -->
<!-- Added by HTTrack --><meta http-equiv="content-type" content="text/html;charset=UTF-8"><!-- /Added by HTTrack -->
</HTML>